HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Location Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-location Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreLocation

A physical or administrative place from the Zambia Health Facility Registry used in facility and reporting-hierarchy routing.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description SΣ 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode SΣ 1..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
... type SΣ 1..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
... contact S 0..* ExtendedContactDetail Official contact details for the location
... address S 1..1 Address Physical location
... form SΣ 0..1 CodeableConcept Physical form of the location
Binding: LocationForm (example): Physical form of the location.
... position S 0..1 BackboneElement The absolute geographic location
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
... managingOrganization SΣ 1..1 Reference(ZM-Core Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(ZM-Core Location Profile) Another Location this one is physically a part of
... characteristic S 0..* CodeableConcept Collection of characteristics (attributes)
Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
... hoursOfOperation S 0..* Availability What days/times during a week is this location usually open (including exceptions)
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required Location Status 📍5.0.0 FHIR Std.
Location.mode Base required Location Mode 📍5.0.0 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
Location.form Base example Location Form 📍5.0.0 FHIR Std.
Location.characteristic Base example Location Characteristic 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a place
... identifier S 1..* Identifier Unique code or number identifying the location to its users
... status S 1..1 code active | suspended | inactive
... name S 1..1 string Name of the location as used by humans
... description S 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode S 1..1 code instance | kind
... type S 1..* CodeableConcept Type of function performed
... contact S 0..* ExtendedContactDetail Official contact details for the location
... address S 1..1 Address Physical location
... form S 0..1 CodeableConcept Physical form of the location
... position S 0..1 BackboneElement The absolute geographic location
... managingOrganization S 1..1 Reference(ZM-Core Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(ZM-Core Location Profile) Another Location this one is physically a part of
... characteristic S 0..* CodeableConcept Collection of characteristics (attributes)
... hoursOfOperation S 0..* Availability What days/times during a week is this location usually open (including exceptions)
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Unique code or number identifying the location to its users
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description SΣ 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode SΣ 1..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
... type SΣ 1..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
... contact S 0..* ExtendedContactDetail Official contact details for the location
... address S 1..1 Address Physical location
... form SΣ 0..1 CodeableConcept Physical form of the location
Binding: LocationForm (example): Physical form of the location.
... position S 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization SΣ 1..1 Reference(ZM-Core Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(ZM-Core Location Profile) Another Location this one is physically a part of
... characteristic S 0..* CodeableConcept Collection of characteristics (attributes)
Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
... hoursOfOperation S 0..* Availability What days/times during a week is this location usually open (including exceptions)
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base required All Languages 📍5.0.0 FHIR Std.
Location.status Base required Location Status 📍5.0.0 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.1
Location.mode Base required Location Mode 📍5.0.0 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
Location.form Base example Location Form 📍5.0.0 FHIR Std.
Location.characteristic Base example Location Characteristic 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a place
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description SΣ 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode SΣ 1..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
... type SΣ 1..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
... contact S 0..* ExtendedContactDetail Official contact details for the location
... address S 1..1 Address Physical location
... form SΣ 0..1 CodeableConcept Physical form of the location
Binding: LocationForm (example): Physical form of the location.
... position S 0..1 BackboneElement The absolute geographic location
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
... managingOrganization SΣ 1..1 Reference(ZM-Core Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(ZM-Core Location Profile) Another Location this one is physically a part of
... characteristic S 0..* CodeableConcept Collection of characteristics (attributes)
Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
... hoursOfOperation S 0..* Availability What days/times during a week is this location usually open (including exceptions)
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required Location Status 📍5.0.0 FHIR Std.
Location.mode Base required Location Mode 📍5.0.0 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
Location.form Base example Location Form 📍5.0.0 FHIR Std.
Location.characteristic Base example Location Characteristic 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a place
... identifier S 1..* Identifier Unique code or number identifying the location to its users
... status S 1..1 code active | suspended | inactive
... name S 1..1 string Name of the location as used by humans
... description S 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode S 1..1 code instance | kind
... type S 1..* CodeableConcept Type of function performed
... contact S 0..* ExtendedContactDetail Official contact details for the location
... address S 1..1 Address Physical location
... form S 0..1 CodeableConcept Physical form of the location
... position S 0..1 BackboneElement The absolute geographic location
... managingOrganization S 1..1 Reference(ZM-Core Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(ZM-Core Location Profile) Another Location this one is physically a part of
... characteristic S 0..* CodeableConcept Collection of characteristics (attributes)
... hoursOfOperation S 0..* Availability What days/times during a week is this location usually open (including exceptions)
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* Location Details and position information for a place
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Unique code or number identifying the location to its users
... status ?!SΣ 1..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
... operationalStatus Σ 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).
... name SΣ 1..1 string Name of the location as used by humans
... alias S 0..* string A list of alternate names that the location is known as, or was known as, in the past
... description SΣ 0..1 markdown Additional details about the location that could be displayed as further information to identify the location beyond its name
... mode SΣ 1..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
... type SΣ 1..* CodeableConcept Type of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.
... contact S 0..* ExtendedContactDetail Official contact details for the location
... address S 1..1 Address Physical location
... form SΣ 0..1 CodeableConcept Physical form of the location
Binding: LocationForm (example): Physical form of the location.
... position S 0..1 BackboneElement The absolute geographic location
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... longitude 1..1 decimal Longitude with WGS84 datum
.... latitude 1..1 decimal Latitude with WGS84 datum
.... altitude 0..1 decimal Altitude with WGS84 datum
... managingOrganization SΣ 1..1 Reference(ZM-Core Organization Profile) Organization responsible for provisioning and upkeep
... partOf S 0..1 Reference(ZM-Core Location Profile) Another Location this one is physically a part of
... characteristic S 0..* CodeableConcept Collection of characteristics (attributes)
Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy).
... hoursOfOperation S 0..* Availability What days/times during a week is this location usually open (including exceptions)
... virtualService 0..* VirtualServiceDetail Connection details of a virtual service (e.g. conference call)
... endpoint S 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base required All Languages 📍5.0.0 FHIR Std.
Location.status Base required Location Status 📍5.0.0 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.1
Location.mode Base required Location Mode 📍5.0.0 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.1
Location.form Base example Location Form 📍5.0.0 FHIR Std.
Location.characteristic Base example Location Characteristic 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron